Skip to content

fix(zod): don't include @@validate rules when generating schema for validating update input #1625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 30, 2024
Merged

fix(zod): don't include @@validate rules when generating schema for validating update input #1625

merged 3 commits into from
Jul 30, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jul 30, 2024

Fixes #1563

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 30, 2024 •
edited
Loading

Walkthrough

Walkthrough

The recent changes enhance the validation logic within the schema and testing framework, specifically regarding model relationships and updates. The conditional refinement of schemas has been simplified, leading to a more straightforward schema generation process. Additionally, integration tests have been updated to enforce stricter validation rules, ensuring references are correctly managed during both creation and updates.

Changes

Files Change Summary
packages/schema/src/plugins/zod/generator.ts Removed conditional wrapping for refineFuncName in prismaUpdateSchema, simplifying schema generation by eliminating dynamic refinement.
tests/integration/tests/enhancements/with-policy/field-validation.test.ts Introduced new requirements for the id field in create method and restructured update tests for stricter validation, including rejections for empty updates.
tests/regression/tests/issue-1563.test.ts Added regression test for validation of model relationships, ensuring refId is enforced correctly on creation and updates of ModelB instances.

Assessment against linked issues

Objective Addressed Explanation
Validations on reference properties don't work on updates (#1563) ✅
Require unique identifiers for records in validation tests (#1563) ✅
Ensure proper handling of dynamic schema modifications (#1563) ❌ Dynamic refinement has been removed, affecting behavior.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jul 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bd8c36c and 9230b71.

Files selected for processing (3)
  • packages/schema/src/plugins/zod/generator.ts (1 hunks)
  • tests/integration/tests/enhancements/with-policy/field-validation.test.ts (2 hunks)
  • tests/regression/tests/issue-1563.test.ts (1 hunks)
Additional comments not posted (4)
tests/regression/tests/issue-1563.test.ts (1)

1-30: Test case for issue #1563 looks good.

The test case is well-structured and verifies the intended fix for validation rules on reference properties during updates.

packages/schema/src/plugins/zod/generator.ts (1)

Line range hint 617-622: Simplification of schema generation logic looks good.

The removal of the conditional block for refineFuncName in the prismaUpdateSchema simplifies the schema generation logic and ensures that the schema is no longer conditionally modified.

tests/integration/tests/enhancements/with-policy/field-validation.test.ts (2)

649-651: Enhancements to the update test case look good.

The changes enhance the validation logic by ensuring that the id field is included in the data object and by restructuring the update method calls to enforce stricter validation rules.

Line range hint 952-956: Enhancements to the null comparison test case look good.

The changes enhance the validation logic by ensuring that the id field is included in the data object and by restructuring the update method calls to enforce stricter validation rules.

@ymc9 ymc9 merged commit 3d7678a into dev Jul 30, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1563-1 branch July 30, 2024 05:09
@coderabbitai coderabbitai bot mentioned this pull request Mar 6, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ymc9